Skip to main content
POST
Reject request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
step_id
string
required

Expected current workflow step ID. A stale step is rejected instead of deciding the next step.

Minimum string length: 1
approver_id
string
required

Identifier of the account member making the decision. Supply exactly one of approver_id or approver_email. With a user token, this must be the authenticated user.

Minimum string length: 1
comment
string
required

Decision comment. Required and nonblank when rejecting; optional when approving. Trimmed, with a maximum of 2000 characters.

Required string length: 1 - 2000

Response

id
string
required

Unique identifier of the approval request.

status
enum<string>
required

Status of this approval execution, independent of downstream entity processing.

Available options:
pending,
approved,
rejected,
cancelled
entity
Quote · object
required

Entity whose operation requires approval.

workflow
object
required

Workflow version used by this request.

requested_by_user_id
string
required

Identifier of the user who requested approval.

requester_comment
string | null
required

Comment supplied when requesting approval.

current_step_id
string | null
required

Identifier of the current step, or null when the request is no longer pending.

steps
object[]
required

Workflow steps in execution order, with their recorded decisions.

created_at
string<date-time>
required

UTC timestamp when this record was created.

Example:

"2024-12-20T16:04:11Z"

completed_at
string<date-time> | null
required

UTC timestamp when the request completed, or null while pending.

Example:

"2024-12-20T16:04:11Z"